<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>EnTech FPK: XboxJoystick Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">EnTech FPK
   &#160;<span id="projectnumber">1</span>
   </div>
   <div id="projectbrief">FRC Programming Kit by the EnTech 281 GreenVillains</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_xbox_joystick-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XboxJoystick Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_xbox_joystick_8hpp_source.html">XboxJoystick.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XboxJoystick:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_xbox_joystick.png" usemap="#XboxJoystick_map" alt=""/>
  <map id="XboxJoystick_map" name="XboxJoystick_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aaa756144cc7f7963ac76492964f1e560"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#aaa756144cc7f7963ac76492964f1e560">XboxAxis</a> { <b>kLeftX</b> = 1, 
<b>kLeftY</b> = 2, 
<b>kRightX</b> = 4, 
<b>kRightY</b> = 5
 }</td></tr>
<tr class="separator:aaa756144cc7f7963ac76492964f1e560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7111bc0fe9e0ba262132450210b0c54"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#ac7111bc0fe9e0ba262132450210b0c54">XboxButton</a> { <br/>
&#160;&#160;<b>kA</b> = 0, 
<b>kB</b> = 1, 
<b>kX</b> = 2, 
<b>kY</b> = 3, 
<br/>
&#160;&#160;<b>kLb</b> = 4, 
<b>kRb</b> = 5, 
<b>kBack</b> = 6, 
<b>kStart</b> = 7, 
<br/>
&#160;&#160;<b>kRightStickPress</b> = 8, 
<b>kLeftStickPress</b> = 9
<br/>
 }</td></tr>
<tr class="separator:ac7111bc0fe9e0ba262132450210b0c54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5a83202d3dc4c615b9100b22139b3bec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#a5a83202d3dc4c615b9100b22139b3bec">XboxJoystick</a> (int joystickPort)</td></tr>
<tr class="separator:a5a83202d3dc4c615b9100b22139b3bec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb5223c147803869462e1db8dce37df6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#abb5223c147803869462e1db8dce37df6">~XboxJoystick</a> ()</td></tr>
<tr class="separator:abb5223c147803869462e1db8dce37df6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5afd1e7c0ee438b77ea084711019da30"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#a5afd1e7c0ee438b77ea084711019da30">GetAxisValue</a> (<a class="el" href="class_xbox_joystick.html#aaa756144cc7f7963ac76492964f1e560">XboxAxis</a> axis)</td></tr>
<tr class="separator:a5afd1e7c0ee438b77ea084711019da30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b6bc91395f531f2d2c3fd4de75ac25c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#a5b6bc91395f531f2d2c3fd4de75ac25c">GetButton</a> (<a class="el" href="class_xbox_joystick.html#ac7111bc0fe9e0ba262132450210b0c54">XboxButton</a> button)</td></tr>
<tr class="separator:a5b6bc91395f531f2d2c3fd4de75ac25c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7208078a5e146a0e3775419feb215c30"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#a7208078a5e146a0e3775419feb215c30">GetRightTrigger</a> ()</td></tr>
<tr class="separator:a7208078a5e146a0e3775419feb215c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3da3450671b6ceba83b41df7911380d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xbox_joystick.html#ac3da3450671b6ceba83b41df7911380d">GetLeftTrigger</a> ()</td></tr>
<tr class="separator:ac3da3450671b6ceba83b41df7911380d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_xbox_joystick.html">XboxJoystick</a> class allows you to receive input data from an XBox controller. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aaa756144cc7f7963ac76492964f1e560"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_xbox_joystick.html#aaa756144cc7f7963ac76492964f1e560">XboxJoystick::XboxAxis</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The XboxAxis enum specifies which axis of which analog stick to read from. </p>

</div>
</div>
<a class="anchor" id="ac7111bc0fe9e0ba262132450210b0c54"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_xbox_joystick.html#ac7111bc0fe9e0ba262132450210b0c54">XboxJoystick::XboxButton</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The XboxButton enum specifies which button to read from. </p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5a83202d3dc4c615b9100b22139b3bec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XboxJoystick::XboxJoystick </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>joystickPort</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="class_xbox_joystick.html">XboxJoystick</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">joystickPort</td><td>The port number that the XBox controller is plugged into. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abb5223c147803869462e1db8dce37df6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XboxJoystick::~XboxJoystick </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Destructor for <a class="el" href="class_xbox_joystick.html">XboxJoystick</a>. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5afd1e7c0ee438b77ea084711019da30"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double XboxJoystick::GetAxisValue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_xbox_joystick.html#aaa756144cc7f7963ac76492964f1e560">XboxAxis</a>&#160;</td>
          <td class="paramname"><em>axis</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the current value of the specified axis.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">axis</td><td>The XboxAxis to read from. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current value of the axis. </dd></dl>

</div>
</div>
<a class="anchor" id="a5b6bc91395f531f2d2c3fd4de75ac25c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool XboxJoystick::GetButton </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_xbox_joystick.html#ac7111bc0fe9e0ba262132450210b0c54">XboxButton</a>&#160;</td>
          <td class="paramname"><em>button</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the current value of the specified button.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">button</td><td>The XboxButton to read from. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the button. </dd></dl>

</div>
</div>
<a class="anchor" id="ac3da3450671b6ceba83b41df7911380d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool XboxJoystick::GetLeftTrigger </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get whether the left trigger (LT) is mostly pressed.</p>
<dl class="section return"><dt>Returns</dt><dd>Whether the left trigger (LT) is mostly pressed. </dd></dl>

</div>
</div>
<a class="anchor" id="a7208078a5e146a0e3775419feb215c30"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool XboxJoystick::GetRightTrigger </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get whether the right trigger (RT) is mostly pressed.</p>
<dl class="section return"><dt>Returns</dt><dd>Whether the right trigger (RT) is mostly pressed. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/Inputs/<a class="el" href="_xbox_joystick_8hpp_source.html">XboxJoystick.hpp</a></li>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/Inputs/XboxJoystick.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 12 2013 16:46:52 for EnTech FPK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
